home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / gui / bgui11b.lha / docs / indicatorclass.doc < prev    next >
Encoding:
Text File  |  1994-11-23  |  2.6 KB  |  94 lines
  1.  
  2.            $RCSfile: indicatorclass.doc,v $
  3.         Description: Indicatorclass documentation.
  4.           Copyright: (C) Copyright 1994 Jaba Development.
  5.                      (C) Copyright 1994 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8.             $Author: jaba $
  9.           $Revision: 1.1 $
  10.               $Date: 1994/07/04 21:05:30 $
  11. ------------------------------------------------------------------------------
  12.  
  13. TABLE OF CONTENTS
  14.  
  15. indicatorclass/--background--
  16. indicatorclass/Methods
  17. indicatorclass/Attributes
  18.  
  19. indicatorclass/--background--                    indicatorclass/--background--
  20.  
  21.     NAME
  22.         Class:          indicatorclass
  23.         Superclass:     baseclass
  24.         Include File:   <libraries/bgui.h>
  25.  
  26.     FUNCTION
  27.         To  provide  a  textual level indicator for gadget objects which might
  28.         need this like the slider and progress classes. As this class may also
  29.         be  useful  in  conjunction with other third party classes it has been
  30.         made available.
  31.  
  32.         Objects of this class do not send out notification events.
  33.  
  34. indicatorclass/Methods                                  indicatorclass/Methods
  35.  
  36.     NEW METHODS
  37.         None.
  38.  
  39.     CHANGED METHODS
  40.         None.
  41.  
  42. indicatorclass/Attributes                            indicatorclass/Attributes
  43.  
  44.     NAME
  45.         INDIC_Min, INDIC_Max -- ( LONG )
  46.  
  47.     FUNCTION
  48.         Set the minimum and maximum possible level indication.
  49.  
  50.         Defaults are 0 minimum and 100 maximum. Applicability is (I).
  51.  
  52.     SEE ALSO
  53.         INDIC_Level
  54.  
  55.     NAME
  56.         INDIC_Level -- ( LONG )
  57.  
  58.     FUNCTION
  59.         Set or update the current level to indication.
  60.  
  61.         Default is 0. Applicability is (ISU).
  62.  
  63.     SEE ALSO
  64.         INDIC_Min, INDIC_Max, INDIC_FormatString
  65.  
  66.     NAME
  67.         INDIC_FormatString -- ( STRPTR )
  68.  
  69.     FUNCTION
  70.         Set  the  C-style  format  string  which is used to format the current
  71.         level before rendering.
  72.  
  73.         NOTE: Since  V38  of  the  library  it  is  possible  to  use locale's
  74.               FormatString()  formatting  codes.  Locale  specific  formatting
  75.               codes will only work when the locale.library is available.
  76.  
  77.         Default is "%ld". Applicability is (I).
  78.  
  79.     SEE ALSO
  80.         exec.library/RawDoFmt(), INDIC_Level
  81.  
  82.     NAME
  83.         INDIC_Justification -- ( ULONG )
  84.  
  85.     FUNCTION
  86.         Set  the  justification  of the textual output. These are the possible
  87.         justification types:
  88.  
  89.         IDJ_LEFT        - Left-justify text output.
  90.         IDJ_CENTER      - Center text output.
  91.         IDF_RIGHT       - Right-justify text output.
  92.  
  93.         Default is IDJ_LEFT. Applicability is (I).
  94.